Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Switch to jupyter-sphinx for user guide pages #1380

Closed
wants to merge 2 commits into from

Conversation

kandersolar
Copy link
Member

  • Closes Enable Jupyter Sphinx Extension in docs? #1379
  • I am familiar with the contributing guidelines
  • Tests added
  • Updates entries to docs/sphinx/source/api.rst for API changes.
  • Adds description and name entries in the appropriate "what's new" file in docs/sphinx/source/whatsnew for all changes. Includes link to the GitHub Issue with :issue:`num` or this Pull Request with :pull:`num`. Includes contributor name and/or GitHub username (link with :ghuser:`user`).
  • New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.
  • Pull request is nearly complete and ready for detailed review.
  • Maintainer: Appropriate GitHub Labels and Milestone are assigned to the Pull Request and linked Issue.

This PR is intended to further discussion of #1379 and is not necessarily intended to ever be merged.

@AdamRJensen
Copy link
Member

@kanderso-nrel Perhaps jupytext as an alternative?

@kandersolar
Copy link
Member Author

Does jupytext integrate with sphinx? I haven't used it but had the impression it was a sort of standalone format converter.

In any case I think making any changes like this would be better to do in a fresh PR, so I'll go ahead and close this one :)

@kandersolar kandersolar deleted the jupyter-sphinx branch July 27, 2022 19:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enable Jupyter Sphinx Extension in docs?
2 participants